Search results

Types

Classes
Interfaces
Enums
Functions
Type aliases
Constants

Members

Properties
Methods
Getters
Setters
Enum members
Show privates

Other

In this module only
index / detritus-client / InteractionCommandClient

Class InteractionCommandClient

extends EventSpewerclass EventSpewerdetritus-utils/EventSpewer

Defined in interactioncommandclient

Interaction Command Client, hooks onto a ClusterClient or ShardClient to provide easier command handling Flow is onInteractionCheck -> onCommandCheck

Constructor

constructor(
token: ClusterClientclass ClusterClientdetritus-client/ClusterClient | CommandClientclass CommandClientdetritus-client/CommandClient | ShardClientclass ShardClientdetritus-client/ShardClient | string,
options: InteractionCommandClientOptionsinterface InteractionCommandClientOptionsdetritus-client/InteractionCommandClientOptions = {}
)

Properties

_clientSubscriptions: Array<EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription>external Array = Array<never>external Array[src]
client: ClusterClientclass ClusterClientdetritus-client/ClusterClient | ShardClientclass ShardClientdetritus-client/ShardClient[src]
commands = BaseSetclass BaseSetdetritus-utils/BaseSet<InteractionCommandclass InteractionCommanddetritus-client/interaction/InteractionCommand>[src]
commandsById = BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, BaseSetclass BaseSetdetritus-utils/BaseSet<InteractionCommandclass InteractionCommanddetritus-client/interaction/InteractionCommand>>[src]
directories = BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, {subdirectories: boolean}>[src]
ratelimits: Array<CommandRatelimitclass CommandRatelimitdetritus-client/commandratelimit/CommandRatelimit>external Array = Array<never>external Array[src]
ratelimiter: CommandRatelimiterclass CommandRatelimiterdetritus-client/commandratelimit/CommandRatelimiter[src]

Methods

onCommandCheck(
context: InteractionContextclass InteractionContextdetritus-client/interaction/InteractionContext,
command: InteractionCommandclass InteractionCommanddetritus-client/interaction/InteractionCommand
): Promise<boolean>external Promise | boolean[src]
onCommandCancel(
context: InteractionContextclass InteractionContextdetritus-client/interaction/InteractionContext,
command: InteractionCommandclass InteractionCommanddetritus-client/interaction/InteractionCommand
): Promise<any>external Promise | any[src]
onInteractionCheck(
context: InteractionContextclass InteractionContextdetritus-client/interaction/InteractionContext
): Promise<boolean>external Promise | boolean[src]
onInteractionCancel(context: InteractionContextclass InteractionContextdetritus-client/interaction/InteractionContext): Promise<any>external Promise | any[src]
get manager(): ClusterProcessChildclass ClusterProcessChilddetritus-client/cluster/ClusterProcessChild | null[src]
get rest(): Clientclass Clientdetritus-client-rest/Client | RestClientclass RestClientdetritus-client/rest/RestClient[src]
add(
options: InteractionCommandclass InteractionCommanddetritus-client/interaction/InteractionCommand | InteractionCommandClientAddOptionsinterface InteractionCommandClientAddOptionsdetritus-client/InteractionCommandClientAddOptions,
run?: CommandCallbackRuntype CommandCallbackRundetritus-client/interaction/CommandCallbackRun
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
addMultiple(
commands: Array<InteractionCommandclass InteractionCommanddetritus-client/interaction/InteractionCommand | InteractionCommandOptionsinterface InteractionCommandOptionsdetritus-client/interaction/InteractionCommandOptions>external Array = Array<never>external Array
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
addMultipleIn(
directory: string,
options: {isAbsolute?: boolean, subdirectories?: boolean} = {}
): Promise<InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient>external Promise[src]
resetCommands(): Promise<void>external Promise[src]
createApplicationCommandsFromRaw(
data: Array<any>external Array
): BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, ApplicationCommandclass ApplicationCommanddetritus-client/structures/ApplicationCommand>[src]
fetchApplicationCommands(
guildId?: string
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, ApplicationCommandclass ApplicationCommanddetritus-client/structures/ApplicationCommand>>external Promise[src]
uploadApplicationCommands(
guildId?: string
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, ApplicationCommandclass ApplicationCommanddetritus-client/structures/ApplicationCommand>>external Promise[src]
validateCommands(
commands: BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, ApplicationCommandclass ApplicationCommanddetritus-client/structures/ApplicationCommand>
): boolean[src]
validateCommandsFromRaw(data: Array<any>external Array): boolean[src]
parseArgs(
context: InteractionContextclass InteractionContextdetritus-client/interaction/InteractionContext,
data: InteractionDataApplicationCommandclass InteractionDataApplicationCommanddetritus-client/structures/InteractionDataApplicationCommand
): Promise<[ParsedArgstype ParsedArgsdetritus-client/interaction/ParsedArgs, ParsedErrorstype ParsedErrorsdetritus-client/interaction/ParsedErrors | null]>external Promise[src]
parseArgsFromContextMenu(
data: InteractionDataApplicationCommandclass InteractionDataApplicationCommanddetritus-client/structures/InteractionDataApplicationCommand
): Promise<[ParsedArgstype ParsedArgsdetritus-client/interaction/ParsedArgs, null]>external Promise[src]
parseArgsFromOptions(
context: InteractionContextclass InteractionContextdetritus-client/interaction/InteractionContext,
commandOptions?: BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, InteractionCommandOptionclass InteractionCommandOptiondetritus-client/interaction/InteractionCommandOption>,
options?: BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, InteractionDataApplicationCommandOptionclass InteractionDataApplicationCommandOptiondetritus-client/structures/InteractionDataApplicationCommandOption>,
resolved?: InteractionDataApplicationCommandResolvedclass InteractionDataApplicationCommandResolveddetritus-client/structures/InteractionDataApplicationCommandResolved
): Promise<[ParsedArgstype ParsedArgsdetritus-client/interaction/ParsedArgs, ParsedErrorstype ParsedErrorsdetritus-client/interaction/ParsedErrors | null]>external Promise[src]
parseDefaultArgsFromOptions(
context: InteractionContextclass InteractionContextdetritus-client/interaction/InteractionContext,
commandOptions: BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, InteractionCommandOptionclass InteractionCommandOptiondetritus-client/interaction/InteractionCommandOption>,
args: ParsedArgstype ParsedArgsdetritus-client/interaction/ParsedArgs = {},
errors: ParsedErrorstype ParsedErrorsdetritus-client/interaction/ParsedErrors = {}
): Promise<boolean>external Promise[src]
run(
options: InteractionCommandClientRunOptionsinterface InteractionCommandClientRunOptionsdetritus-client/InteractionCommandClientRunOptions = {}
): Promise<ClusterClientclass ClusterClientdetritus-client/ClusterClient | ShardClientclass ShardClientdetritus-client/ShardClient>external Promise[src]
handleInteractionCreate(event: InteractionCreateinterface InteractionCreatedetritus-client/gateway/GatewayClientEvents/InteractionCreate): Promise<void>external Promise[src]
handle(
name: ClientEvents.INTERACTION_CREATEenum ClientEventsdetritus-client/ClientEvents,
event: InteractionCreateinterface InteractionCreatedetritus-client/gateway/GatewayClientEvents/InteractionCreate
): Promise<void>external Promise[src]
on(
event: string | symbol,
listener: (...args: any[]) => void
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
16 more overloads
on(
event: ClientEvents.COMMAND_ERRORenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandErrorinterface CommandErrordetritus-client/interaction/InteractionCommandEvents/CommandError) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: "commandError",
listener: (payload: CommandErrorinterface CommandErrordetritus-client/interaction/InteractionCommandEvents/CommandError) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: ClientEvents.COMMAND_FAILenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandFailinterface CommandFaildetritus-client/interaction/InteractionCommandEvents/CommandFail) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: "commandFail",
listener: (payload: CommandFailinterface CommandFaildetritus-client/interaction/InteractionCommandEvents/CommandFail) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: ClientEvents.COMMAND_PERMISSIONS_FAIL_CLIENTenum ClientEventsdetritus-client/ClientEvents,
listener: (
payload: CommandPermissionsFailClientinterface CommandPermissionsFailClientdetritus-client/interaction/InteractionCommandEvents/CommandPermissionsFailClient
) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: "commandPermissionsFailClient",
listener: (
payload: CommandPermissionsFailClientinterface CommandPermissionsFailClientdetritus-client/interaction/InteractionCommandEvents/CommandPermissionsFailClient
) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: ClientEvents.COMMAND_PERMISSIONS_FAILenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandPermissionsFailinterface CommandPermissionsFaildetritus-client/interaction/InteractionCommandEvents/CommandPermissionsFail) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: "commandPermissionsFail",
listener: (payload: CommandPermissionsFailinterface CommandPermissionsFaildetritus-client/interaction/InteractionCommandEvents/CommandPermissionsFail) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: ClientEvents.COMMAND_RANenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandRaninterface CommandRandetritus-client/interaction/InteractionCommandEvents/CommandRan) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: "commandRan",
listener: (payload: CommandRaninterface CommandRandetritus-client/interaction/InteractionCommandEvents/CommandRan) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: ClientEvents.COMMAND_RATELIMITenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandRatelimitinterface CommandRatelimitdetritus-client/interaction/InteractionCommandEvents/CommandRatelimit) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: "commandRatelimit",
listener: (payload: CommandRatelimitinterface CommandRatelimitdetritus-client/interaction/InteractionCommandEvents/CommandRatelimit) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: ClientEvents.COMMAND_RUN_ERRORenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandRunErrorinterface CommandRunErrordetritus-client/interaction/InteractionCommandEvents/CommandRunError) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: "commandRunError",
listener: (payload: CommandRunErrorinterface CommandRunErrordetritus-client/interaction/InteractionCommandEvents/CommandRunError) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: ClientEvents.KILLEDenum ClientEventsdetritus-client/ClientEvents,
listener: () => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
on(
event: string | symbol,
listener: (...args: any[]) => void
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: string | symbol,
listener: (...args: any[]) => void
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
16 more overloads
once(
event: ClientEvents.COMMAND_ERRORenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandErrorinterface CommandErrordetritus-client/interaction/InteractionCommandEvents/CommandError) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: "commandError",
listener: (payload: CommandErrorinterface CommandErrordetritus-client/interaction/InteractionCommandEvents/CommandError) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: ClientEvents.COMMAND_FAILenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandFailinterface CommandFaildetritus-client/interaction/InteractionCommandEvents/CommandFail) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: "commandFail",
listener: (payload: CommandFailinterface CommandFaildetritus-client/interaction/InteractionCommandEvents/CommandFail) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: ClientEvents.COMMAND_PERMISSIONS_FAIL_CLIENTenum ClientEventsdetritus-client/ClientEvents,
listener: (
payload: CommandPermissionsFailClientinterface CommandPermissionsFailClientdetritus-client/interaction/InteractionCommandEvents/CommandPermissionsFailClient
) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: "commandPermissionsFailClient",
listener: (
payload: CommandPermissionsFailClientinterface CommandPermissionsFailClientdetritus-client/interaction/InteractionCommandEvents/CommandPermissionsFailClient
) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: ClientEvents.COMMAND_PERMISSIONS_FAILenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandPermissionsFailinterface CommandPermissionsFaildetritus-client/interaction/InteractionCommandEvents/CommandPermissionsFail) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: "commandPermissionsFail",
listener: (payload: CommandPermissionsFailinterface CommandPermissionsFaildetritus-client/interaction/InteractionCommandEvents/CommandPermissionsFail) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: ClientEvents.COMMAND_RANenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandRaninterface CommandRandetritus-client/interaction/InteractionCommandEvents/CommandRan) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: "commandRan",
listener: (payload: CommandRaninterface CommandRandetritus-client/interaction/InteractionCommandEvents/CommandRan) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: ClientEvents.COMMAND_RATELIMITenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandRatelimitinterface CommandRatelimitdetritus-client/interaction/InteractionCommandEvents/CommandRatelimit) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: "commandRatelimit",
listener: (payload: CommandRatelimitinterface CommandRatelimitdetritus-client/interaction/InteractionCommandEvents/CommandRatelimit) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: ClientEvents.COMMAND_RUN_ERRORenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandRunErrorinterface CommandRunErrordetritus-client/interaction/InteractionCommandEvents/CommandRunError) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: "commandRunError",
listener: (payload: CommandRunErrorinterface CommandRunErrordetritus-client/interaction/InteractionCommandEvents/CommandRunError) => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: ClientEvents.KILLEDenum ClientEventsdetritus-client/ClientEvents,
listener: () => any
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
once(
event: string | symbol,
listener: (...args: any[]) => void
): InteractionCommandClientclass InteractionCommandClientdetritus-client/InteractionCommandClient[src]
subscribe(
event: string | symbol,
listener: (...args: any[]) => void
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
17 more overloads
subscribe(
event: ClientEvents.COMMAND_ERRORenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandErrorinterface CommandErrordetritus-client/interaction/InteractionCommandEvents/CommandError) => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: "commandError",
listener: (payload: CommandErrorinterface CommandErrordetritus-client/interaction/InteractionCommandEvents/CommandError) => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: ClientEvents.COMMAND_FAILenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandFailinterface CommandFaildetritus-client/interaction/InteractionCommandEvents/CommandFail) => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: "commandFail",
listener: (payload: CommandFailinterface CommandFaildetritus-client/interaction/InteractionCommandEvents/CommandFail) => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: ClientEvents.COMMAND_PERMISSIONS_FAIL_CLIENTenum ClientEventsdetritus-client/ClientEvents,
listener: (
payload: CommandPermissionsFailClientinterface CommandPermissionsFailClientdetritus-client/interaction/InteractionCommandEvents/CommandPermissionsFailClient
) => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: "commandPermissionsFailClient",
listener: (
payload: CommandPermissionsFailClientinterface CommandPermissionsFailClientdetritus-client/interaction/InteractionCommandEvents/CommandPermissionsFailClient
) => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: ClientEvents.COMMAND_PERMISSIONS_FAILenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandPermissionsFailinterface CommandPermissionsFaildetritus-client/interaction/InteractionCommandEvents/CommandPermissionsFail) => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: "commandPermissionsFail",
listener: (payload: CommandPermissionsFailinterface CommandPermissionsFaildetritus-client/interaction/InteractionCommandEvents/CommandPermissionsFail) => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: ClientEvents.COMMAND_RANenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandRaninterface CommandRandetritus-client/interaction/InteractionCommandEvents/CommandRan) => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: "commandRan",
listener: (payload: CommandRaninterface CommandRandetritus-client/interaction/InteractionCommandEvents/CommandRan) => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: ClientEvents.COMMAND_RATELIMITenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandRatelimitinterface CommandRatelimitdetritus-client/interaction/InteractionCommandEvents/CommandRatelimit) => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: "commandRatelimit",
listener: (payload: CommandRatelimitinterface CommandRatelimitdetritus-client/interaction/InteractionCommandEvents/CommandRatelimit) => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: ClientEvents.COMMAND_RUN_ERRORenum ClientEventsdetritus-client/ClientEvents,
listener: (payload: CommandRunErrorinterface CommandRunErrordetritus-client/interaction/InteractionCommandEvents/CommandRunError) => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: "commandRunError",
listener: (payload: CommandRunErrorinterface CommandRunErrordetritus-client/interaction/InteractionCommandEvents/CommandRunError) => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: ClientEvents.KILLEDenum ClientEventsdetritus-client/ClientEvents,
listener: () => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: "killed",
listener: () => any
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]
subscribe(
event: string | symbol,
listener: (...args: any[]) => void
): EventSubscriptionclass EventSubscriptiondetritus-utils/EventSubscription[src]